ODFocusSet

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODFocusSet

Superclasses
ODObject
Subclasses
none

An object of the ODFocusSet class provides grouping of foci for activation.

Description
A focus is a designation of ownership of a given shared resource or feature, such as the keyboard or menu bar. A frame that owns a focus receives events pertaining to that resource. Foci may be manipulated singly or in groups called focus sets. A focus set is a list of foci that can be obtained and released as a group. For example, if a frame wants to request ownership of keyboard and menu foci together, it can create a focus set that includes these two focus types. If a frame requests a focus set and one or more of the foci included in the focus set is not available, ownership of the entire focus set is denied.
Your part creates a focus set object by calling the arbitrator's CreateFocusSet method (page 46), which returns a reference to a focus set object. Frames obtain ownership of focus sets by calling the arbitrator's RequestFocusSet method (page 54). For more information about foci and focus sets, see the ODFocusSetIterator class description (page 290) and the chapter on user events in the OpenDoc Programmer's Guide for the MacOS.

Methods
This section presents summary descriptions of the ODFocusSet methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Iterating

CreateIterator
Creates a focus-set iterator object for this focus set.
Adding and Removing Foci

Add
Adds the specified focus to this focus set.
Remove
Removes the specified focus from this focus set.
Testing

Contains
Returns a Boolean value that indicates whether the specified focus is a member of this focus set.

Methods
Add
Contains
CreateIterator
Remove